'Declaration
 
Public Overloads Function Add(Of TKey)( _
   ByVal keySelector As Expression(Of Func(Of T,TKey)), _
   ByVal keyIsUnique As Boolean, _
   ByVal onlyOnce As Boolean, _
   ByVal algorithm As IndexingAlgorithm, _
   ByVal locale As CultureInfo _
) As IIndexScanner(Of T,TKey)

public IIndexScanner<T,TKey> Add<TKey>( 
   Expression<Func<T,TKey>> keySelector,
   bool keyIsUnique,
   bool onlyOnce,
   IndexingAlgorithm algorithm,
   CultureInfo locale
)

Parameters

keySelector

Key selector expression of the index, see KeySelector.

keyIsUnique

Specifies whether the key used in this index is a unique key for the indexed collection (default: false).

onlyOnce

Specifies whether it is required that the index does not exist prior to this method call (default: false). If an index with this keySelector already exists, an exception is thrown if it is true, and this method call is ignored if it is false.

algorithm

An IndexingAlgorithm used by the index. In the current version, only one algorithm is supported, RedBlackTree. Later versions may support other algorithms, such as bitmap or hash indexes.

locale

Locale information used to compare strings in the index (default: CultureInfo.CurrentCulture).

Type Parameters

TKey

The type of the index key.

Return Value

A unique index occupies less memory and performs better than a non-unique index (although the difference isn't dramatic). Therefore, for unique keys, it's recommended to specify the corresponding index as unique.

But do that only if you are sure that the key is indeed unique, as it imposes a uniqueness constraint on the indexed collection. An attempt to modify the indexed collection violating the uniqueness throws an System.InvalidOperationException.

Reference

ScannerCollection<T> Class
ScannerCollection<T> Members
Overload List